DocuGenerate bietet sicheren Zugang zu seiner API durch die Verwendung von API-Schlüsseln, die es Entwicklern ermöglichen, auf die DocuGenerate-Plattform zuzugreifen und sie in ihre eigenen Anwendungen zu integrieren.
Ihren API-Schlüssel finden Sie auf der Settings-Seite. Zur Authentifizierung muss der API-Schlüssel in allen API-Anfragen an den Server enthalten sein, und zwar im Header Authorization: <API Key>
Vorlagen sind die Bausteine von DocuGenerate und ermöglichen die Erstellung hochwertiger Dokumente mit einheitlicher Formatierung. Mit Vorlagen können Sie die Struktur Ihrer Dokumente einmal festlegen und sie dann wiederholt verwenden, um neue Dokumente zu erstellen.
Um eine neue Vorlage zu erstellen, müssen Sie eine POST-Anfrage an https://api.docugenerate.com/v1/template mit dem Parameter file senden, der auf die Vorlagendatei verweist. Achten Sie darauf, multipart/form-data als Content-Type zu verwenden.
DocuGenerate antwortet mit einem JSON Objekt, das die Eigenschaften der Vorlage enthält, einschließlich der Liste der erkannten Tags.
curl -X 'POST' \
'https://api.docugenerate.com/v1/template' \
-H 'Accept: application/json' \
-H 'Authorization: 491c000c5fad32ed7787005b0723ad55' \
-H 'Content-Type: multipart/form-data' \
-F 'file=@Business Letter.docx;type=application/vnd.openxmlformats-officedocument.wordprocessingml.document' \
-F 'name=' \
-F 'delimiters={
"left": "[",
"right": "]"
}' \
-F 'region=us' \
-F 'enhanced_syntax=false' \
-F 'versioning_enabled=true'{
"enhanced_syntax": false,
"versioning_enabled": true,
"tags": {
"valid": [
"Date",
"Name",
"Job Title",
"Company Name",
"Street Address",
"City",
"State",
"Zip Code",
"Email",
"Phone"
],
"invalid": []
},
"created": 1748863881127,
"updated": 1748863881127,
"name": "Business Letter",
"delimiters": {
"left": "[",
"right": "]"
},
"filename": "Business Letter.docx",
"format": ".docx",
"region": "us",
"page_count": 1,
"image_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/templates%2Fbet2oQirk0pSd9ctH9Qu%2FBusiness%20Letter.png?alt=media&token=d534d7f0-ccb6-4d6d-a9cf-7ffa55e82b95",
"preview_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/templates%2Fbet2oQirk0pSd9ctH9Qu%2FBusiness%20Letter.pdf?alt=media&token=8f60f256-c454-4ffc-a8da-670431a62e82",
"template_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/templates%2Fbet2oQirk0pSd9ctH9Qu%2FBusiness%20Letter.docx?alt=media&token=0904bdf4-6046-4c03-a612-ebdf145fdee5",
"id": "bet2oQirk0pSd9ctH9Qu"
}
Sie erstellen Dokumente, indem Sie eine POST-Anfrage an https://api.docugenerate.com/v1/document mit den Parametern template_id und data senden. Als Content-Type kann multipart/form-data oder application/json verwendet werden.
Der Parameter data muss ein JSON-Objekt mit den Werten sein, die in die Vorlage eingefügt werden. Ein Dokument wird erstellt, indem die Zusammenführungs-Tags der Vorlage durch die Werte des Objekts ersetzt werden. Jeder Schlüssel des Objekts muss exakt dem Namen eines Tags in der Vorlage entsprechen, einschließlich Leerzeichen und Groß- und Kleinschreibung.
{
"Name": "Emily Carter",
"Job Title": "Operations Manager",
"Company Name": "Harbor Point Consulting",
"Street Address": "118 West Street",
"City": "Annapolis",
"State": "Maryland",
"Zip Code": "21405",
"Email": "emily.carter@example.com",
"Phone": "(410) 555-0142"
}
curl -X 'POST' \
'https://api.docugenerate.com/v1/document' \
-H 'Accept: application/json' \
-H 'Authorization: 491c000c5fad32ed7787005b0723ad55' \
-H 'Content-Type: multipart/form-data' \
-F 'template_id=bet2oQirk0pSd9ctH9Qu' \
-F 'output_quality=100' \
-F 'attach=' \
-F 'output_name=' \
-F 'data={ "Name": "Emily Carter", "Job Title": "Operations Manager", "Company Name": "Harbor Point Consulting", "Street Address": "118 West Street", "City": "Annapolis", "State": "Maryland", "Zip Code": "21405", "Email": "emily.carter@example.com", "Phone": "(410) 555-0142" }' \
-F 'name=' \
-F 'merge_with=' \
-F 'page_break=true' \
-F 'single_file=true' \
-F 'output_format=.pdf' DocuGenerate antwortet mit einem JSON Objekt mit den Dokumenteigenschaften, einschließlich document_uri, das auf die URL des generierten Dokuments verweist. Das output_format des generierten Dokuments kann .docx, .pdf, .doc, .odt oder .txt sein.
{
"created": 1791125416372,
"template_id": "bet2oQirk0pSd9ctH9Qu",
"name": "Business Letter",
"format": ".pdf",
"data_length": 1,
"filename": "Business Letter.pdf",
"document_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/documents%2FiESelthRt4uaYQRTemrL%2FBusiness%20Letter.pdf?alt=media&token=c4b259ec-249b-4b35-a62f-6a8dc0da75f3",
"id": "iESelthRt4uaYQRTemrL"
}
Die DocuGenerate-API funktioniert mit jeder Programmiersprache, die HTTP-Anfragen senden kann. Unsere ausführlichen Anleitungen enthalten Schritt-für-Schritt-Anweisungen für Node.js, Python, PHP, Ruby, Go, C#, Rust und Java, mit sofort einsetzbaren Codebeispielen für jede API-Methode.
Jede Anleitung deckt den gesamten Ablauf ab, vom Hochladen einer Vorlage bis zum Generieren und Herunterladen von Dokumenten. Entdecken Sie alle Sprachen auf der Übersichtsseite API-SDKs und generieren Sie in wenigen Minuten Dokumente aus Ihren Anwendungen.
Eine vollständige Liste aller verfügbaren Endpunkte, einschließlich Informationen zu den Anfrage-Body-Parametern und Antwort-Schemata, finden Sie auf der API-Referenz-Seite.
Diese Endpunkte bilden die Grundlage der DocuGenerate-Plattform und bieten ein umfassendes Set an Werkzeugen zur Verwaltung von Vorlagen und Dokumenten. Durch die Nutzung dieser Ressourcen können Sie einfach robuste Workflows zur Dokumentenerstellung aufbauen, die auf die spezifischen Anforderungen Ihres Unternehmens zugeschnitten werden können.
Bei Fragen zur Nutzung der DocuGenerate-API finden Sie zahlreiche nützliche Ressourcen in unserem API-Hilfe-Center.
Starten Sie mit 20 kostenlosen Dokumenten pro Monat und führen Sie in wenigen Minuten Ihren ersten API-Aufruf durch.